Skip to main content

AutoretrieveApi

All URIs are relative to //api.estuary.tech/

MethodHTTP requestDescription
AdminAutoretrieveInitPostPost /admin/autoretrieve/initRegister autoretrieve server
AdminAutoretrieveListGetGet /admin/autoretrieve/listList autoretrieve servers
AutoretrieveHeartbeatPostPost /autoretrieve/heartbeatMarks autoretrieve server as up

AdminAutoretrieveInitPost

string AdminAutoretrieveInitPost(ctx, addresses, pubKey) Register autoretrieve server

This endpoint registers a new autoretrieve server

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
addressesstring
pubKeystring

Return type

string

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AdminAutoretrieveListGet

string AdminAutoretrieveListGet(ctx, ) List autoretrieve servers

This endpoint lists all registered autoretrieve servers

Required Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AutoretrieveHeartbeatPost

string AutoretrieveHeartbeatPost(ctx, token) Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
tokenstringAutoretrieve's auth token

Return type

string

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]